/**
 * @(#)${NAME}.java Feb 21, 2007
 *
 * Copyright (c) 2005-2010 Psiqueware S.A. de C.V. All Rights Reserved.
 * This software is the proprietary information Psiqueware S.A. de C.V.
 * Use is subject to license terms.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * <br/>Usuario : Psique
 * <br/>Creaci&oacute;n: Feb 21, 2007 - 10:51:14 AM
 * <br/>
 * <br/>
 * <br/><t5>Cambios :</t5>
 * <br/><b>Fecha | Autor  |  Cambios</b>
 * <ul>
 * <li>Feb 21, 2007 | <a href = "mailto:AngelElectrico@PsiqueWare.com">Psique</a> | Creaci&oacute;n del Objeto.</li>
 * <li>Abr 19, 2007 | <a href = "mailto:AngelElectrico@PsiqueWare.com">Psique</a> | Se eliminar&oacute;n las referencias a las clases Empresa, Deportamento, etc y se cambiar&oacute;n por referencias a Estructura.</li>
 *
 * </ul>
 */

package com.psiqueware.jazmin.empresas.recursos.humanos.compensaciones.dao;

import com.psiqueware.alheli.dao.AlreadyPersistedObjectException;
import com.psiqueware.alheli.dao.BaseDAO;
import com.psiqueware.alheli.dao.DAOException;
import com.psiqueware.alheli.dao.EnlaceTransaccional;
import com.psiqueware.alheli.dao.NotAPersistedObjectException;
import com.psiqueware.jazmin.empresas.recursos.humanos.compensaciones.EstructuraSalarial;
import com.psiqueware.tulipan.organizacional.Estructura;

import java.util.List;

/**
 * Contrato de operaciones CRUD para el objeto EstructuraSalarial.
 * <br/>Paquete Original: com.psiqueware.laVIE.empresas.empleados.compensaciones.dao
 * <br/>Nombre  Original: EstructuraSalarialDAO
 * <br/><a href="EstructuraSalarialDAO.java.html"><i>Ver C&oacute;digo Fuente</i> </a>
 *
 * @author <a href="mailto:AngelElectrico@PsiqueWare.com">Psique</a>
 * @version Revision: 1.1 Feb 21, 2007 10:51:14 AM
 * @noinspection DuplicateThrows
 */
public interface EstructuraSalarialDAO extends BaseDAO
{

    /**
     * Guarda un {@link EstructuraSalarial} en persistencia.
     * Este {@link EstructuraSalarial} no exist&iacute;a previamente en persistencia.
     *
     * @param o                   EstructuraSalarialK a persistir.
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @return EstructuraSalarialK despu&eacute;s de persistirse.
     *
     * @throws com.psiqueware.alheli.dao.AlreadyPersistedObjectException
     *          en caso de que este {@link EstructuraSalarial} ya existiera en persistencia.
     * @throws com.psiqueware.alheli.dao.DAOException
     *
     */
    EstructuraSalarial saveEstructuraSalarial ( EstructuraSalarial o, EnlaceTransaccional enlaceTransaccional ) throws AlreadyPersistedObjectException, DAOException;

    /**
     * Actualiza un {@link EstructuraSalarial} en persistencia
     *
     * @param o                   EstructuraSalarial a actualizar
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @return {@link EstructuraSalarial} actualizado
     *
     * @throws com.psiqueware.alheli.dao.NotAPersistedObjectException
     *          en caso de que este {@link EstructuraSalarial} no existiera en persistencia.
     * @throws com.psiqueware.alheli.dao.DAOException
     *
     */
    EstructuraSalarial updateEstructuraSalarial ( EstructuraSalarial o, EnlaceTransaccional enlaceTransaccional ) throws NotAPersistedObjectException, DAOException;

    /**
     * Devuelve un {@link EstructuraSalarial} a partir de su id.
     *
     * @param id                  del {@link EstructuraSalarial} que se busca
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @return {@link EstructuraSalarial} en caso de encontrarlo, <code>null</code> en otro caso.
     *
     * @throws com.psiqueware.alheli.dao.DAOException
     *          si se presenta alg&uacute;n problema.
     */
    EstructuraSalarial findEstructuraSalarialPorId ( Long id, EnlaceTransaccional enlaceTransaccional ) throws DAOException;

    /**
     * Eliminar un {@link EstructuraSalarial} del sistema de persistencia.
     *
     * @param o                   EstructuraSalarial que se pretende elimninar.
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @throws com.psiqueware.alheli.dao.NotAPersistedObjectException
     *          si dicho objeto no exist&iacute;a en persistencia.
     * @throws com.psiqueware.alheli.dao.DAOException
     *          si no se puede comunicar a la base de datos.
     */
    void deleteEstructuraSalarial ( EstructuraSalarial o, EnlaceTransaccional enlaceTransaccional ) throws NotAPersistedObjectException, DAOException;

    /**
     * Devuelve un listado de los {@link EstructuraSalarial} que se encuentran en persistencia.
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @return List de {@link EstructuraSalarial} en caso de encontrarlo, una lista vacia en caso contrario.
     *
     * @throws com.psiqueware.alheli.dao.DAOException
     *          si se presenta alg&uacute;n problema.
     */
    List<EstructuraSalarial> listEstructuraSalarial ( EnlaceTransaccional enlaceTransaccional ) throws DAOException;


    /**
     * Nos dice si ya fu&eacute; creada una {@link EstructuraSalarial} en la Empresa con dicha clave.
     * <b>Importante:</b> A la implementaci&oacute;n no debe importar si son may&uacute;sculas o min&uacute;sculas.
     *
     * @param clave   a buscar.
     * @param estructura donde se cre&oacute; la Clave.
     *
     * @return <code>true</code> si ya existe dicha estructura; <code>false</code> en caso contrario.
     *
     * @noinspection InstanceMethodNamingConvention,BooleanMethodNameMustStartWithQuestion
     */
    boolean existeEstructuraSalarialPorClaveIdEstructura ( final String clave, final Estructura estructura );
}
